Conversation
Apply these principles to all components: 1. Each property is defined in a separate .type.ts file in a type called <ComponentName>Props. 2. That file is the prime source of truth for the properties' descriptions 3. The type is imported to the component as $$Props 4. All props are typed using that. 5. At the top of the file, there is a Svelte doc with `@component` 6. The `### Properties` section is generated from the type file such that `@default` is replaced with 'Default:' and the value is backticked. 7. The element or component onto which $$restProps is passed and which is the base of the props type, is mentioned last as like '- Any valid attributes of a `<figure>` element' 8. Any other prop related headings can be removed along with their contents, unless they contain relevant information missing from the type, in which case add the info to the type 9. If the component doesn't follow this paradigm, create the type file, export it from index.ts and import it to the component Co-Author: Claude
- Add TypeDoc configuration for packages and frontend libraries - Create script to extract Svelte @component docstrings - Create route map generator for SvelteKit routes - Create main orchestrator script for all documentation - Add npm scripts: docs:generate, docs:typedoc, docs:components, docs:routes - Add comprehensive documentation about the auto-doc system - Update .gitignore to exclude generated documentation - Add dependencies: typedoc, typedoc-plugin-markdown, typedoc-plugin-mermaid, tsx, glob The system generates: 1. TypeDoc API docs for all packages and frontend libs 2. Component docs from Svelte @component docstrings (markdown) 3. Links to corresponding .type.ts TypeDoc documentation 4. Route map from SvelteKit routes directory 5. Integration of README.md files from directories 6. Comprehensive table of contents 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Kalle Järvenpää <kaljarv@users.noreply.github.com>
The function is no longer supported. Also remove the associated .env variables.
Add README's and in-code documentation. Also, harmonize some tsdoc formatting.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements a comprehensive documentation site for OpenVAA, replacing the old website and significantly expanding documentation. The changes include automated documentation generation systems, extensive rewrites of existing docs, package updates, and minor fixes to other packages.
Changes:
- Implements an automated documentation generation system for components, routes, and navigation
- Extensively rewrites and extends current documentation with publisher and developer guides
- Adds a new
docspackage with SvelteKit-based documentation site - Updates various packages and removes deprecated features (LOAD_DATA_ON_INITIALISE_FOLDER)
Reviewed changes
Copilot reviewed 163 out of 485 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/package.json | Adds new docs package with dependencies and build scripts |
| docs/tsconfig.json | TypeScript configuration for docs package |
| docs/svelte.config.js | SvelteKit configuration with mdsvex for markdown processing |
| docs/src/routes/layout.css | Tailwind and DaisyUI styling configuration |
| docs/src/routes/+layout.svelte | Root layout with header and footer |
| docs/src/routes/(content)/+layout.svelte | Content layout with navigation sidebar |
| docs/src/lib/components/* | Reusable components for documentation site |
| docs/src/lib/layouts/* | Layout components for markdown content |
| docs/src/lib/utils/navigation.ts | Navigation utilities for the docs site |
| docs/scripts/* | Scripts for automated documentation generation |
| docs/src/routes/(content)/publishers-guide/* | Publisher guide documentation pages |
| docs/src/routes/(content)/developers-guide/* | Developer guide documentation pages |
| docs/src/routes/(content)/about/* | About section pages |
| README.md | Updated to point to new documentation site |
| CLAUDE.md | Updated reference to code review checklist |
| .env.example | Reorganized and improved documentation of environment variables |
| backend/vaa-strapi/src/constants.ts | Removed LOAD_DATA_ON_INITIALISE_FOLDER |
| backend/vaa-strapi/src/index.ts | Removed loadData functionality |
| .lintstagedrc.json | Updated ESLint flag name |
| .github/workflows/docs.yml | New workflow for deploying documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Jan 25, 2026
Add a `docs` package that contains the partially auto-generated documentation for the repo as well as general information about the OpenVAA association. Move all existing documentation there and add new content, including research excerpts.
Also, remove deprecated configs from frontend eslint config.
Otherwise `yarn install --immutable` will fail.
Due to the different Svelte version for `docs` and `frontend`, prettier must be run separatly for `docs` and the rest of the repo. This can be reverted when both Svelte versions are aligned.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements #322